<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>v_frmbuf_wr: Overview</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">v_frmbuf_wr
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__v__frmbuf__wr.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Overview</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:gaf6ba82d79d84ccc4ee6b505eb629c045"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__wr.html#gaf6ba82d79d84ccc4ee6b505eb629c045">XVFrmbufWr_HandlerType</a> { <a class="el" href="group__v__frmbuf__wr.html#ggaf6ba82d79d84ccc4ee6b505eb629c045a3cc801c2a0990cf5bde03a385fd993d0">XVFRMBUFWR_HANDLER_DONE</a> = 1, 
<a class="el" href="group__v__frmbuf__wr.html#ggaf6ba82d79d84ccc4ee6b505eb629c045a651f28f6436d0d5ae6be2581e6871ca7">XVFRMBUFWR_HANDLER_READY</a>
 }</td></tr>
<tr class="memdesc:gaf6ba82d79d84ccc4ee6b505eb629c045"><td class="mdescLeft">&#160;</td><td class="mdescRight">These constants specify different types of handler and used to differentiate interrupt requests from peripheral.  <a href="group__v__frmbuf__wr.html#gaf6ba82d79d84ccc4ee6b505eb629c045">More...</a><br/></td></tr>
<tr class="separator:gaf6ba82d79d84ccc4ee6b505eb629c045"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga6f9c9835e23af3fdd01c837846daa6ce"><td class="memItemLeft" align="right" valign="top">XVidC_ColorFormat&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__wr.html#ga6f9c9835e23af3fdd01c837846daa6ce">WrMemory2Live</a> (XVidC_ColorFormat MemFmt)</td></tr>
<tr class="memdesc:ga6f9c9835e23af3fdd01c837846daa6ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function maps the memory video formats to the live/stream video formats.  <a href="#ga6f9c9835e23af3fdd01c837846daa6ce">More...</a><br/></td></tr>
<tr class="separator:ga6f9c9835e23af3fdd01c837846daa6ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5453dda299a1e77ed1c692f31dbcb844"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__wr.html#ga5453dda299a1e77ed1c692f31dbcb844">XVFrmbufWr_Initialize</a> (<a class="el" href="struct_x_v___frmbuf_wr__l2.html">XV_FrmbufWr_l2</a> *InstancePtr, u16 DeviceId)</td></tr>
<tr class="memdesc:ga5453dda299a1e77ed1c692f31dbcb844"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function initializes the core instance.  <a href="#ga5453dda299a1e77ed1c692f31dbcb844">More...</a><br/></td></tr>
<tr class="separator:ga5453dda299a1e77ed1c692f31dbcb844"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga918ae9aa7c4a277140c79880b91b5217"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__wr.html#ga918ae9aa7c4a277140c79880b91b5217">XVFrmbufWr_InterruptEnable</a> (<a class="el" href="struct_x_v___frmbuf_wr__l2.html">XV_FrmbufWr_l2</a> *InstancePtr, u32 IrqMask)</td></tr>
<tr class="memdesc:ga918ae9aa7c4a277140c79880b91b5217"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function enables interrupts in the core.  <a href="#ga918ae9aa7c4a277140c79880b91b5217">More...</a><br/></td></tr>
<tr class="separator:ga918ae9aa7c4a277140c79880b91b5217"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacb9da6afd1c85b903b5d19048f2079f4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__wr.html#gacb9da6afd1c85b903b5d19048f2079f4">XVFrmbufWr_InterruptDisable</a> (<a class="el" href="struct_x_v___frmbuf_wr__l2.html">XV_FrmbufWr_l2</a> *InstancePtr, u32 IrqMask)</td></tr>
<tr class="memdesc:gacb9da6afd1c85b903b5d19048f2079f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function disables interrupts in the core.  <a href="#gacb9da6afd1c85b903b5d19048f2079f4">More...</a><br/></td></tr>
<tr class="separator:gacb9da6afd1c85b903b5d19048f2079f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga62c170ef332a536b7461b3ce81def351"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__wr.html#ga62c170ef332a536b7461b3ce81def351">XVFrmbufWr_Start</a> (<a class="el" href="struct_x_v___frmbuf_wr__l2.html">XV_FrmbufWr_l2</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga62c170ef332a536b7461b3ce81def351"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function starts the core instance.  <a href="#ga62c170ef332a536b7461b3ce81def351">More...</a><br/></td></tr>
<tr class="separator:ga62c170ef332a536b7461b3ce81def351"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0cfe9c77cc5534a27e613e5fc87a8ab4"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__wr.html#ga0cfe9c77cc5534a27e613e5fc87a8ab4">XVFrmbufWr_Stop</a> (<a class="el" href="struct_x_v___frmbuf_wr__l2.html">XV_FrmbufWr_l2</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga0cfe9c77cc5534a27e613e5fc87a8ab4"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function stops the core instance.  <a href="#ga0cfe9c77cc5534a27e613e5fc87a8ab4">More...</a><br/></td></tr>
<tr class="separator:ga0cfe9c77cc5534a27e613e5fc87a8ab4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga28dc4f189245f3c9e8152ff270a40813"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__wr.html#ga28dc4f189245f3c9e8152ff270a40813">XVFrmbufWr_WaitForIdle</a> (<a class="el" href="struct_x_v___frmbuf_wr__l2.html">XV_FrmbufWr_l2</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga28dc4f189245f3c9e8152ff270a40813"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function Waits for the core to reach idle state.  <a href="#ga28dc4f189245f3c9e8152ff270a40813">More...</a><br/></td></tr>
<tr class="separator:ga28dc4f189245f3c9e8152ff270a40813"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4951453d9f7373886327dbbcb8b3ada2"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__wr.html#ga4951453d9f7373886327dbbcb8b3ada2">XVFrmbufWr_SetMemFormat</a> (<a class="el" href="struct_x_v___frmbuf_wr__l2.html">XV_FrmbufWr_l2</a> *InstancePtr, u32 StrideInBytes, XVidC_ColorFormat MemFmt, const XVidC_VideoStream *StrmIn)</td></tr>
<tr class="memdesc:ga4951453d9f7373886327dbbcb8b3ada2"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function configures the frame buffer write memory output.  <a href="#ga4951453d9f7373886327dbbcb8b3ada2">More...</a><br/></td></tr>
<tr class="separator:ga4951453d9f7373886327dbbcb8b3ada2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga628707a22dc9888af5371e4e7fc82b68"><td class="memItemLeft" align="right" valign="top">XVidC_VideoStream *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__wr.html#ga628707a22dc9888af5371e4e7fc82b68">XVFrmbufWr_GetVideoStream</a> (<a class="el" href="struct_x_v___frmbuf_wr__l2.html">XV_FrmbufWr_l2</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga628707a22dc9888af5371e4e7fc82b68"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function reads the pointer to the output stream configuration.  <a href="#ga628707a22dc9888af5371e4e7fc82b68">More...</a><br/></td></tr>
<tr class="separator:ga628707a22dc9888af5371e4e7fc82b68"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga65a4ff585ac85c574eb6111848e3b2c9"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__wr.html#ga65a4ff585ac85c574eb6111848e3b2c9">XVFrmbufWr_SetBufferAddr</a> (<a class="el" href="struct_x_v___frmbuf_wr__l2.html">XV_FrmbufWr_l2</a> *InstancePtr, UINTPTR Addr)</td></tr>
<tr class="memdesc:ga65a4ff585ac85c574eb6111848e3b2c9"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets the buffer address.  <a href="#ga65a4ff585ac85c574eb6111848e3b2c9">More...</a><br/></td></tr>
<tr class="separator:ga65a4ff585ac85c574eb6111848e3b2c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafd87229d20fa2601db7c527f10d4425f"><td class="memItemLeft" align="right" valign="top">UINTPTR&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__wr.html#gafd87229d20fa2601db7c527f10d4425f">XVFrmbufWr_GetBufferAddr</a> (<a class="el" href="struct_x_v___frmbuf_wr__l2.html">XV_FrmbufWr_l2</a> *InstancePtr)</td></tr>
<tr class="memdesc:gafd87229d20fa2601db7c527f10d4425f"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function reads the buffer address.  <a href="#gafd87229d20fa2601db7c527f10d4425f">More...</a><br/></td></tr>
<tr class="separator:gafd87229d20fa2601db7c527f10d4425f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae3ad3f1fa2f369041d8e9ab7683a05b0"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__wr.html#gae3ad3f1fa2f369041d8e9ab7683a05b0">XVFrmbufWr_SetChromaBufferAddr</a> (<a class="el" href="struct_x_v___frmbuf_wr__l2.html">XV_FrmbufWr_l2</a> *InstancePtr, UINTPTR Addr)</td></tr>
<tr class="memdesc:gae3ad3f1fa2f369041d8e9ab7683a05b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets the buffer address for the UV plane for semi-planar formats or Only U Plane for 3 planar formats.  <a href="#gae3ad3f1fa2f369041d8e9ab7683a05b0">More...</a><br/></td></tr>
<tr class="separator:gae3ad3f1fa2f369041d8e9ab7683a05b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaeea208892ad56d1c83915b753f15d6f3"><td class="memItemLeft" align="right" valign="top">UINTPTR&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__wr.html#gaeea208892ad56d1c83915b753f15d6f3">XVFrmbufWr_GetChromaBufferAddr</a> (<a class="el" href="struct_x_v___frmbuf_wr__l2.html">XV_FrmbufWr_l2</a> *InstancePtr)</td></tr>
<tr class="memdesc:gaeea208892ad56d1c83915b753f15d6f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function reads the buffer address for the UV plane for semi-planar formats or Only U plane for 3 planar formats.  <a href="#gaeea208892ad56d1c83915b753f15d6f3">More...</a><br/></td></tr>
<tr class="separator:gaeea208892ad56d1c83915b753f15d6f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf68f85db7571469e49626a9483567a50"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__wr.html#gaf68f85db7571469e49626a9483567a50">XVFrmbufWr_SetVChromaBufferAddr</a> (<a class="el" href="struct_x_v___frmbuf_wr__l2.html">XV_FrmbufWr_l2</a> *InstancePtr, UINTPTR Addr)</td></tr>
<tr class="memdesc:gaf68f85db7571469e49626a9483567a50"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets the buffer address for the V plane for 3 planar formats.  <a href="#gaf68f85db7571469e49626a9483567a50">More...</a><br/></td></tr>
<tr class="separator:gaf68f85db7571469e49626a9483567a50"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf5b5f5abec7d6763bd3333f3ef4df008"><td class="memItemLeft" align="right" valign="top">UINTPTR&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__wr.html#gaf5b5f5abec7d6763bd3333f3ef4df008">XVFrmbufWr_GetVChromaBufferAddr</a> (<a class="el" href="struct_x_v___frmbuf_wr__l2.html">XV_FrmbufWr_l2</a> *InstancePtr)</td></tr>
<tr class="memdesc:gaf5b5f5abec7d6763bd3333f3ef4df008"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function reads the buffer address for the V plane for 3 planar formats.  <a href="#gaf5b5f5abec7d6763bd3333f3ef4df008">More...</a><br/></td></tr>
<tr class="separator:gaf5b5f5abec7d6763bd3333f3ef4df008"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga02ac61b5da119e29efb4fcb6bb0a8340"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__wr.html#ga02ac61b5da119e29efb4fcb6bb0a8340">XVFrmbufWr_GetFieldID</a> (<a class="el" href="struct_x_v___frmbuf_wr__l2.html">XV_FrmbufWr_l2</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga02ac61b5da119e29efb4fcb6bb0a8340"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function reads the field ID.  <a href="#ga02ac61b5da119e29efb4fcb6bb0a8340">More...</a><br/></td></tr>
<tr class="separator:ga02ac61b5da119e29efb4fcb6bb0a8340"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7aa0fd061e4c759a245ec57b551d8d21"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__wr.html#ga7aa0fd061e4c759a245ec57b551d8d21">XVFrmbufWr_DbgReportStatus</a> (<a class="el" href="struct_x_v___frmbuf_wr__l2.html">XV_FrmbufWr_l2</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga7aa0fd061e4c759a245ec57b551d8d21"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function reports the frame buffer write status.  <a href="#ga7aa0fd061e4c759a245ec57b551d8d21">More...</a><br/></td></tr>
<tr class="separator:ga7aa0fd061e4c759a245ec57b551d8d21"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaaef29cb5e2485c63e589f6f0621eac9d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__wr.html#gaaef29cb5e2485c63e589f6f0621eac9d">XVFrmbufWr_SetCallback</a> (<a class="el" href="struct_x_v___frmbuf_wr__l2.html">XV_FrmbufWr_l2</a> *InstancePtr, u32 HandlerType, void *CallbackFunc, void *CallbackRef)</td></tr>
<tr class="memdesc:gaaef29cb5e2485c63e589f6f0621eac9d"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function installs an asynchronous callback function for the given HandlerType:  <a href="#gaaef29cb5e2485c63e589f6f0621eac9d">More...</a><br/></td></tr>
<tr class="separator:gaaef29cb5e2485c63e589f6f0621eac9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadea6cdf3f0eca400d18bf3b31b87e9c7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__frmbuf__wr.html#gadea6cdf3f0eca400d18bf3b31b87e9c7">XVFrmbufWr_InterruptHandler</a> (void *InstancePtr)</td></tr>
<tr class="memdesc:gadea6cdf3f0eca400d18bf3b31b87e9c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is the interrupt handler for the frame buffer write core driver.  <a href="#gadea6cdf3f0eca400d18bf3b31b87e9c7">More...</a><br/></td></tr>
<tr class="separator:gadea6cdf3f0eca400d18bf3b31b87e9c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="gaf6ba82d79d84ccc4ee6b505eb629c045"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__v__frmbuf__wr.html#gaf6ba82d79d84ccc4ee6b505eb629c045">XVFrmbufWr_HandlerType</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>These constants specify different types of handler and used to differentiate interrupt requests from peripheral. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ggaf6ba82d79d84ccc4ee6b505eb629c045a3cc801c2a0990cf5bde03a385fd993d0"></a>XVFRMBUFWR_HANDLER_DONE</em>&nbsp;</td><td class="fielddoc">
<p>Handler for ap_done. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ggaf6ba82d79d84ccc4ee6b505eb629c045a651f28f6436d0d5ae6be2581e6871ca7"></a>XVFRMBUFWR_HANDLER_READY</em>&nbsp;</td><td class="fielddoc">
<p>Handler for ap_ready. </p>
</td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga6f9c9835e23af3fdd01c837846daa6ce"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">XVidC_ColorFormat WrMemory2Live </td>
          <td>(</td>
          <td class="paramtype">XVidC_ColorFormat&#160;</td>
          <td class="paramname"><em>MemFmt</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function maps the memory video formats to the live/stream video formats. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">MemFmt</td><td>is the video format written to memory</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Live/Stream Video Format associated with that memory format </dd></dl>

<p>Referenced by <a class="el" href="group__v__frmbuf__wr.html#ga4951453d9f7373886327dbbcb8b3ada2">XVFrmbufWr_SetMemFormat()</a>.</p>

</div>
</div>
<a class="anchor" id="ga7aa0fd061e4c759a245ec57b551d8d21"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XVFrmbufWr_DbgReportStatus </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___frmbuf_wr__l2.html">XV_FrmbufWr_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function reports the frame buffer write status. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to core instance to be worked upon</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none</dd></dl>
<dl class="section note"><dt>Note</dt><dd>none </dd></dl>

<p>References <a class="el" href="struct_x_v__frmbufwr___config.html#a2d873c1229a4efdfb3b132febf4e6054">XV_frmbufwr_Config::AXIMMDataWidth</a>, <a class="el" href="struct_x_v__frmbufwr___config.html#aeb8502aaff6a176ce7e341aaee9d9e5b">XV_frmbufwr_Config::BaseAddress</a>, <a class="el" href="struct_x_v__frmbufwr___config.html#af7418f3cef2a522d8a07de17f27beaf0">XV_frmbufwr_Config::BGR8En</a>, <a class="el" href="struct_x_v__frmbufwr___config.html#a1244f566a1a1b59fb78cd8ff67546d9f">XV_frmbufwr_Config::BGRA8En</a>, <a class="el" href="struct_x_v__frmbufwr___config.html#affabcb9afaae10e168f41c86bb65a5e4">XV_frmbufwr_Config::BGRX8En</a>, <a class="el" href="struct_x_v__frmbufwr.html#ac6a008e283f98889377df951199c4a5b">XV_frmbufwr::Config</a>, <a class="el" href="struct_x_v___frmbuf_wr__l2.html#a82fac99cfaebc558120fd4b5060fc146">XV_FrmbufWr_l2::FrmbufWr</a>, <a class="el" href="struct_x_v__frmbufwr___config.html#afafb31ab816487c4ea1c6917877d4756">XV_frmbufwr_Config::Interlaced</a>, <a class="el" href="struct_x_v__frmbufwr___config.html#ac574dd89449209b1554a4ef8ef5910d2">XV_frmbufwr_Config::IsTileFormat</a>, <a class="el" href="struct_x_v__frmbufwr___config.html#a55eb9329a50385463b2ffee562d7a412">XV_frmbufwr_Config::MaxDataWidth</a>, <a class="el" href="struct_x_v__frmbufwr___config.html#a067ead64f4f249d893081d4626bdb7a1">XV_frmbufwr_Config::PixPerClk</a>, <a class="el" href="struct_x_v__frmbufwr___config.html#a0eb86933af24e047d9d788911d392a59">XV_frmbufwr_Config::RGB16En</a>, <a class="el" href="struct_x_v__frmbufwr___config.html#a4a70d8a48b279f47454c31ace3d98537">XV_frmbufwr_Config::RGB8En</a>, <a class="el" href="struct_x_v__frmbufwr___config.html#a95974beb075b3efe207f9e1dafb4f2e6">XV_frmbufwr_Config::RGBA8En</a>, <a class="el" href="struct_x_v__frmbufwr___config.html#acc0d8d95810220131ae2fd05bfea510b">XV_frmbufwr_Config::RGBX10En</a>, <a class="el" href="struct_x_v__frmbufwr___config.html#ae156ad4718023fca2082c142af8d41cd">XV_frmbufwr_Config::RGBX12En</a>, <a class="el" href="struct_x_v__frmbufwr___config.html#ac548249d4fb2d38cbeb7ed827ea0406b">XV_frmbufwr_Config::RGBX8En</a>, <a class="el" href="struct_x_v__frmbufwr___config.html#a5fb22c767589f7ac9907658e794410bd">XV_frmbufwr_Config::UYVY8En</a>, <a class="el" href="struct_x_v__frmbufwr___config.html#a484d8c15d711cbdfb6e6300b30cd86ac">XV_frmbufwr_Config::Y10En</a>, <a class="el" href="struct_x_v__frmbufwr___config.html#a8ca1895a8e8e6efac3f7a43afef4e70d">XV_frmbufwr_Config::Y12En</a>, <a class="el" href="struct_x_v__frmbufwr___config.html#aaa2568bb221210bc9ec40f50728ccdeb">XV_frmbufwr_Config::Y16En</a>, <a class="el" href="struct_x_v__frmbufwr___config.html#abb9d8670bacdb461826280d4b4d0ca58">XV_frmbufwr_Config::Y8En</a>, <a class="el" href="struct_x_v__frmbufwr___config.html#a976b7966d720ef9c3715e3a15aa4ad9f">XV_frmbufwr_Config::Y_U_V10En</a>, <a class="el" href="struct_x_v__frmbufwr___config.html#a5a49842833f295dc487194669b7e7b26">XV_frmbufwr_Config::Y_U_V12En</a>, <a class="el" href="struct_x_v__frmbufwr___config.html#aa4f0f0ff5f962f0cf226c5a0a81ffcc3">XV_frmbufwr_Config::Y_U_V8_420En</a>, <a class="el" href="struct_x_v__frmbufwr___config.html#a02cb5132600b415cf96413e670a48fb7">XV_frmbufwr_Config::Y_U_V8En</a>, <a class="el" href="struct_x_v__frmbufwr___config.html#a6343b4718c758a936f88260b75fdb9d8">XV_frmbufwr_Config::Y_UV10_420En</a>, <a class="el" href="struct_x_v__frmbufwr___config.html#a5651ac036c199d567fbfc959b45ab851">XV_frmbufwr_Config::Y_UV10En</a>, <a class="el" href="struct_x_v__frmbufwr___config.html#a2b040d207d56e4bcd25bc14f3c7ada6a">XV_frmbufwr_Config::Y_UV12_420En</a>, <a class="el" href="struct_x_v__frmbufwr___config.html#a349670d3d649db955c67c2568cb46ea5">XV_frmbufwr_Config::Y_UV12En</a>, <a class="el" href="struct_x_v__frmbufwr___config.html#a672d02f25d386c7be4440dba913e3dd5">XV_frmbufwr_Config::Y_UV16_420En</a>, <a class="el" href="struct_x_v__frmbufwr___config.html#ab1f1518f054922be6d8182ee800ef2be">XV_frmbufwr_Config::Y_UV16En</a>, <a class="el" href="struct_x_v__frmbufwr___config.html#a572639ec51d3fa31d68db3b6858efb58">XV_frmbufwr_Config::Y_UV8_420En</a>, <a class="el" href="struct_x_v__frmbufwr___config.html#a7097af5d0a0ccade82a0b46390a58e90">XV_frmbufwr_Config::Y_UV8En</a>, <a class="el" href="struct_x_v__frmbufwr___config.html#aa3c18b07cb491e9291fe51cb1d7a7d8e">XV_frmbufwr_Config::YUV16En</a>, <a class="el" href="struct_x_v__frmbufwr___config.html#af3f6c4be98b97d0eccc8e369ffc7a075">XV_frmbufwr_Config::YUV8En</a>, <a class="el" href="struct_x_v__frmbufwr___config.html#af470e3e1051588fa101a8a2d66a41f98">XV_frmbufwr_Config::YUVA8En</a>, <a class="el" href="struct_x_v__frmbufwr___config.html#a11846c69aa1f47eb12feca413f52b4d4">XV_frmbufwr_Config::YUVX10En</a>, <a class="el" href="struct_x_v__frmbufwr___config.html#a7450b05b1587fea637ebcb6fda9fea65">XV_frmbufwr_Config::YUVX12En</a>, <a class="el" href="struct_x_v__frmbufwr___config.html#ac748ffbcfd0366d78166463be3da9d25">XV_frmbufwr_Config::YUVX8En</a>, and <a class="el" href="struct_x_v__frmbufwr___config.html#aa5956711c68040c3aefe3ad6bfda14f7">XV_frmbufwr_Config::YUYV8En</a>.</p>

</div>
</div>
<a class="anchor" id="gafd87229d20fa2601db7c527f10d4425f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">UINTPTR XVFrmbufWr_GetBufferAddr </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___frmbuf_wr__l2.html">XV_FrmbufWr_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function reads the buffer address. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to core instance to be worked upon</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Address of buffer in memory </dd></dl>

<p>References <a class="el" href="struct_x_v___frmbuf_wr__l2.html#a82fac99cfaebc558120fd4b5060fc146">XV_FrmbufWr_l2::FrmbufWr</a>.</p>

</div>
</div>
<a class="anchor" id="gaeea208892ad56d1c83915b753f15d6f3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">UINTPTR XVFrmbufWr_GetChromaBufferAddr </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___frmbuf_wr__l2.html">XV_FrmbufWr_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function reads the buffer address for the UV plane for semi-planar formats or Only U plane for 3 planar formats. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to core instance to be worked upon</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Address of buffer in memory </dd></dl>

<p>References <a class="el" href="struct_x_v___frmbuf_wr__l2.html#a82fac99cfaebc558120fd4b5060fc146">XV_FrmbufWr_l2::FrmbufWr</a>.</p>

</div>
</div>
<a class="anchor" id="ga02ac61b5da119e29efb4fcb6bb0a8340"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XVFrmbufWr_GetFieldID </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___frmbuf_wr__l2.html">XV_FrmbufWr_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function reads the field ID. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to core instance to be worked upon</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Field ID </dd></dl>

<p>References <a class="el" href="struct_x_v__frmbufwr.html#ac6a008e283f98889377df951199c4a5b">XV_frmbufwr::Config</a>, <a class="el" href="struct_x_v___frmbuf_wr__l2.html#a82fac99cfaebc558120fd4b5060fc146">XV_FrmbufWr_l2::FrmbufWr</a>, and <a class="el" href="struct_x_v__frmbufwr___config.html#afafb31ab816487c4ea1c6917877d4756">XV_frmbufwr_Config::Interlaced</a>.</p>

</div>
</div>
<a class="anchor" id="gaf5b5f5abec7d6763bd3333f3ef4df008"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">UINTPTR XVFrmbufWr_GetVChromaBufferAddr </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___frmbuf_wr__l2.html">XV_FrmbufWr_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function reads the buffer address for the V plane for 3 planar formats. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to core instance to be worked upon</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Address of buffer in memory </dd></dl>

<p>References <a class="el" href="struct_x_v___frmbuf_wr__l2.html#a82fac99cfaebc558120fd4b5060fc146">XV_FrmbufWr_l2::FrmbufWr</a>.</p>

</div>
</div>
<a class="anchor" id="ga628707a22dc9888af5371e4e7fc82b68"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">XVidC_VideoStream* XVFrmbufWr_GetVideoStream </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___frmbuf_wr__l2.html">XV_FrmbufWr_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function reads the pointer to the output stream configuration. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to core instance to be worked upon</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pointer to output stream configuration </dd></dl>

<p>References <a class="el" href="struct_x_v___frmbuf_wr__l2.html#af870fc8343e9486ded17e4094e4eb0c0">XV_FrmbufWr_l2::Stream</a>.</p>

</div>
</div>
<a class="anchor" id="ga5453dda299a1e77ed1c692f31dbcb844"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XVFrmbufWr_Initialize </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___frmbuf_wr__l2.html">XV_FrmbufWr_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>DeviceId</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function initializes the core instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to core instance to be worked upon </td></tr>
    <tr><td class="paramname">DeviceId</td><td>is instance id of the core</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if device is found and initialized XST_DEVICE_NOT_FOUND if device is not found </dd></dl>

<p>References <a class="el" href="struct_x_v___frmbuf_wr__l2.html#a82fac99cfaebc558120fd4b5060fc146">XV_FrmbufWr_l2::FrmbufWr</a>.</p>

</div>
</div>
<a class="anchor" id="gacb9da6afd1c85b903b5d19048f2079f4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XVFrmbufWr_InterruptDisable </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___frmbuf_wr__l2.html">XV_FrmbufWr_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>IrqMask</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function disables interrupts in the core. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to core instance to be worked upon</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none </dd></dl>

<p>References <a class="el" href="struct_x_v___frmbuf_wr__l2.html#a82fac99cfaebc558120fd4b5060fc146">XV_FrmbufWr_l2::FrmbufWr</a>.</p>

</div>
</div>
<a class="anchor" id="ga918ae9aa7c4a277140c79880b91b5217"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XVFrmbufWr_InterruptEnable </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___frmbuf_wr__l2.html">XV_FrmbufWr_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>IrqMask</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function enables interrupts in the core. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to core instance to be worked upon</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none </dd></dl>

<p>References <a class="el" href="struct_x_v___frmbuf_wr__l2.html#a82fac99cfaebc558120fd4b5060fc146">XV_FrmbufWr_l2::FrmbufWr</a>.</p>

</div>
</div>
<a class="anchor" id="gadea6cdf3f0eca400d18bf3b31b87e9c7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XVFrmbufWr_InterruptHandler </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is the interrupt handler for the frame buffer write core driver. </p>
<p>This handler clears the pending interrupt and determined if the source is frame done signal. If yes, starts the next frame processing and calls the registered callback function</p>
<p>The application is responsible for connecting this function to the interrupt system. Application beyond this driver is also responsible for providing callbacks to handle interrupts and installing the callbacks using <a class="el" href="group__v__frmbuf__wr.html#gaaef29cb5e2485c63e589f6f0621eac9d" title="This function installs an asynchronous callback function for the given HandlerType: ...">XVFrmbufWr_SetCallback()</a> during initialization phase.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the core instance that just interrupted.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_v___frmbuf_wr__l2.html#a4d9228cc09b69f5b3446732f67f280d2">XV_FrmbufWr_l2::CallbackDoneRef</a>, <a class="el" href="struct_x_v___frmbuf_wr__l2.html#ad3cdab83426b12f82f5fe0ae3eaeb6b5">XV_FrmbufWr_l2::CallbackReadyRef</a>, <a class="el" href="struct_x_v___frmbuf_wr__l2.html#a5ded8485566f62544d2a15261c691a8e">XV_FrmbufWr_l2::FrameDoneCallback</a>, <a class="el" href="struct_x_v___frmbuf_wr__l2.html#a028f3b4708b36fb313634a0f8133ce14">XV_FrmbufWr_l2::FrameReadyCallback</a>, <a class="el" href="struct_x_v___frmbuf_wr__l2.html#a82fac99cfaebc558120fd4b5060fc146">XV_FrmbufWr_l2::FrmbufWr</a>, and <a class="el" href="struct_x_v__frmbufwr.html#a0af44aae5b925aac2e6441f51ff132c7">XV_frmbufwr::IsReady</a>.</p>

</div>
</div>
<a class="anchor" id="ga65a4ff585ac85c574eb6111848e3b2c9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XVFrmbufWr_SetBufferAddr </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___frmbuf_wr__l2.html">XV_FrmbufWr_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">UINTPTR&#160;</td>
          <td class="paramname"><em>Addr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sets the buffer address. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to core instance to be worked upon </td></tr>
    <tr><td class="paramname">Addr</td><td>is the absolute address of buffer in memory</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS or XST_FAILURE </dd></dl>

<p>References <a class="el" href="struct_x_v__frmbufwr.html#ac6a008e283f98889377df951199c4a5b">XV_frmbufwr::Config</a>, <a class="el" href="struct_x_v___frmbuf_wr__l2.html#a82fac99cfaebc558120fd4b5060fc146">XV_FrmbufWr_l2::FrmbufWr</a>, and <a class="el" href="struct_x_v__frmbufwr___config.html#a067ead64f4f249d893081d4626bdb7a1">XV_frmbufwr_Config::PixPerClk</a>.</p>

</div>
</div>
<a class="anchor" id="gaaef29cb5e2485c63e589f6f0621eac9d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XVFrmbufWr_SetCallback </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___frmbuf_wr__l2.html">XV_FrmbufWr_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>HandlerType</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>CallbackFunc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>CallbackRef</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function installs an asynchronous callback function for the given HandlerType: </p>
<pre>
HandlerType                     Callback Function Type
</p>
<hr/>
<p>
(XVFRMBUFWR_HANDLER_DONE)       DoneCallback
(XVFRMBUFWR_HANDLER_READY)      ReadyCallback</pre><pre><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Frame Buffer Write core instance.
</td></tr>
    <tr><td class="paramname">CallbackFunc</td><td>is the address of the callback function.
</td></tr>
    <tr><td class="paramname">CallbackRef</td><td>is a user data item that will be passed to the
          callback function when it is invoked.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if callback function installed successfully.</li>
<li>XST_INVALID_PARAM when HandlerType is invalid.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Invoking this function for a handler that already has been
          installed replaces it with the new handler.
</dd></dl>
</pre>
<p>References <a class="el" href="struct_x_v___frmbuf_wr__l2.html#a4d9228cc09b69f5b3446732f67f280d2">XV_FrmbufWr_l2::CallbackDoneRef</a>, <a class="el" href="struct_x_v___frmbuf_wr__l2.html#ad3cdab83426b12f82f5fe0ae3eaeb6b5">XV_FrmbufWr_l2::CallbackReadyRef</a>, <a class="el" href="struct_x_v___frmbuf_wr__l2.html#a5ded8485566f62544d2a15261c691a8e">XV_FrmbufWr_l2::FrameDoneCallback</a>, <a class="el" href="struct_x_v___frmbuf_wr__l2.html#a028f3b4708b36fb313634a0f8133ce14">XV_FrmbufWr_l2::FrameReadyCallback</a>, <a class="el" href="group__v__frmbuf__wr.html#ggaf6ba82d79d84ccc4ee6b505eb629c045a3cc801c2a0990cf5bde03a385fd993d0">XVFRMBUFWR_HANDLER_DONE</a>, and <a class="el" href="group__v__frmbuf__wr.html#ggaf6ba82d79d84ccc4ee6b505eb629c045a651f28f6436d0d5ae6be2581e6871ca7">XVFRMBUFWR_HANDLER_READY</a>.</p>

</div>
</div>
<a class="anchor" id="gae3ad3f1fa2f369041d8e9ab7683a05b0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XVFrmbufWr_SetChromaBufferAddr </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___frmbuf_wr__l2.html">XV_FrmbufWr_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">UINTPTR&#160;</td>
          <td class="paramname"><em>Addr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sets the buffer address for the UV plane for semi-planar formats or Only U Plane for 3 planar formats. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to core instance to be worked upon </td></tr>
    <tr><td class="paramname">Addr</td><td>is the absolute address of buffer in memory</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS or XST_FAILURE </dd></dl>

<p>References <a class="el" href="struct_x_v__frmbufwr.html#ac6a008e283f98889377df951199c4a5b">XV_frmbufwr::Config</a>, <a class="el" href="struct_x_v___frmbuf_wr__l2.html#a82fac99cfaebc558120fd4b5060fc146">XV_FrmbufWr_l2::FrmbufWr</a>, and <a class="el" href="struct_x_v__frmbufwr___config.html#a067ead64f4f249d893081d4626bdb7a1">XV_frmbufwr_Config::PixPerClk</a>.</p>

</div>
</div>
<a class="anchor" id="ga4951453d9f7373886327dbbcb8b3ada2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XVFrmbufWr_SetMemFormat </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___frmbuf_wr__l2.html">XV_FrmbufWr_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>StrideInBytes</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">XVidC_ColorFormat&#160;</td>
          <td class="paramname"><em>MemFmt</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const XVidC_VideoStream *&#160;</td>
          <td class="paramname"><em>StrmIn</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function configures the frame buffer write memory output. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the core instance to be worked on. </td></tr>
    <tr><td class="paramname">StrideInBytes</td><td>is the memory stride in bytes </td></tr>
    <tr><td class="paramname">MemFormat</td><td>is the video format written to memory </td></tr>
    <tr><td class="paramname">StrmIn</td><td>is the pointer to output stream configuration</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none </dd></dl>

<p>References <a class="el" href="struct_x_v__frmbufwr.html#ac6a008e283f98889377df951199c4a5b">XV_frmbufwr::Config</a>, <a class="el" href="struct_x_v___frmbuf_wr__l2.html#a82fac99cfaebc558120fd4b5060fc146">XV_FrmbufWr_l2::FrmbufWr</a>, <a class="el" href="struct_x_v__frmbufwr___config.html#a067ead64f4f249d893081d4626bdb7a1">XV_frmbufwr_Config::PixPerClk</a>, <a class="el" href="struct_x_v___frmbuf_wr__l2.html#af870fc8343e9486ded17e4094e4eb0c0">XV_FrmbufWr_l2::Stream</a>, <a class="el" href="group__v__frmbuf__wr.html#ga6f9c9835e23af3fdd01c837846daa6ce">WrMemory2Live()</a>, <a class="el" href="xv__frmbufwr__l2_8h.html#a3ffa5d2dc950fdff081a42ad961dd161">XVFrmbufWr_IsBGR8Enabled</a>, <a class="el" href="xv__frmbufwr__l2_8h.html#a06298cf0035199d4636e12983f085b22">XVFrmbufWr_IsBGRA8Enabled</a>, <a class="el" href="xv__frmbufwr__l2_8h.html#acbb8fda38bfa532d79d357c930fbd710">XVFrmbufWr_IsBGRX8Enabled</a>, <a class="el" href="xv__frmbufwr__l2_8h.html#a3c7d4d87d74782c6db765abad80c625e">XVFrmbufWr_IsRGB16Enabled</a>, <a class="el" href="xv__frmbufwr__l2_8h.html#ae801db647299b33a32690e944c71144c">XVFrmbufWr_IsRGB8Enabled</a>, <a class="el" href="xv__frmbufwr__l2_8h.html#a3ddcf48750784db3ed9e3657574fbfa3">XVFrmbufWr_IsRGBA8Enabled</a>, <a class="el" href="xv__frmbufwr__l2_8h.html#a1f483e2f3d75e138566163021144ac6a">XVFrmbufWr_IsRGBX10Enabled</a>, <a class="el" href="xv__frmbufwr__l2_8h.html#af55f5df3f123465de72b53caa4a34e4b">XVFrmbufWr_IsRGBX12Enabled</a>, <a class="el" href="xv__frmbufwr__l2_8h.html#a19aa6a466e3ade4418a6aaa1d347b26c">XVFrmbufWr_IsRGBX8Enabled</a>, <a class="el" href="xv__frmbufwr__l2_8h.html#a914c6863bc6772d35dbb8e706f9135b7">XVFrmbufWr_IsUYVY8Enabled</a>, <a class="el" href="xv__frmbufwr__l2_8h.html#af1770374c9e79b957c4c5da9985ddca1">XVFrmbufWr_IsY10Enabled</a>, <a class="el" href="xv__frmbufwr__l2_8h.html#ae7e66b039f58a353c128e09a25008806">XVFrmbufWr_IsY12Enabled</a>, <a class="el" href="xv__frmbufwr__l2_8h.html#a1ca50a2b60ee7ba60504c6321efe1e78">XVFrmbufWr_IsY16Enabled</a>, <a class="el" href="xv__frmbufwr__l2_8h.html#aa1e55cb22cc4068c537c46a90ac92780">XVFrmbufWr_IsY8Enabled</a>, <a class="el" href="xv__frmbufwr__l2_8h.html#abe23878ea66a281da4f2d821ed9a2d65">XVFrmbufWr_IsY_U_V10Enabled</a>, <a class="el" href="xv__frmbufwr__l2_8h.html#a03a0cc58d98dfc4da5afbca59a4056e4">XVFrmbufWr_IsY_U_V12Enabled</a>, <a class="el" href="xv__frmbufwr__l2_8h.html#a09e410360830349a5bca4514100c5545">XVFrmbufWr_IsY_U_V8_420Enabled</a>, <a class="el" href="xv__frmbufwr__l2_8h.html#a30d57ef8f9b7a9b5f592dfccdd2b4db2">XVFrmbufWr_IsY_U_V8Enabled</a>, <a class="el" href="xv__frmbufwr__l2_8h.html#a545f80fb4a287747fa9d6dc835841779">XVFrmbufWr_IsY_UV10_420Enabled</a>, <a class="el" href="xv__frmbufwr__l2_8h.html#a4c43d86c33361db3072a00a0f196dbea">XVFrmbufWr_IsY_UV10Enabled</a>, <a class="el" href="xv__frmbufwr__l2_8h.html#a76ec6759bf3524942f26f59fe48a8e94">XVFrmbufWr_IsY_UV12_420Enabled</a>, <a class="el" href="xv__frmbufwr__l2_8h.html#a394705c264fe5d43663a824dfbede5a8">XVFrmbufWr_IsY_UV12Enabled</a>, <a class="el" href="xv__frmbufwr__l2_8h.html#a25f61b4550f870bd9735b682beb871d0">XVFrmbufWr_IsY_UV16_420Enabled</a>, <a class="el" href="xv__frmbufwr__l2_8h.html#ad5e7ff34825a3fe149b5f43f6b882d3e">XVFrmbufWr_IsY_UV16Enabled</a>, <a class="el" href="xv__frmbufwr__l2_8h.html#a452143cc276f467abcd82f6e6fd18477">XVFrmbufWr_IsY_UV8_420Enabled</a>, <a class="el" href="xv__frmbufwr__l2_8h.html#adf587e3fcdfc069da29ea00b1723208b">XVFrmbufWr_IsY_UV8Enabled</a>, <a class="el" href="xv__frmbufwr__l2_8h.html#a41a8ea3874374bd7703cbc26c0171da5">XVFrmbufWr_IsYUV16Enabled</a>, <a class="el" href="xv__frmbufwr__l2_8h.html#a33f7a0ee2961e09ad812606492b19486">XVFrmbufWr_IsYUV8Enabled</a>, <a class="el" href="xv__frmbufwr__l2_8h.html#a822a5f30db2ef890e73c1708b3f969f8">XVFrmbufWr_IsYUVA8Enabled</a>, <a class="el" href="xv__frmbufwr__l2_8h.html#ae3a212bbac15f70252c90abde8b945c7">XVFrmbufWr_IsYUVX10Enabled</a>, <a class="el" href="xv__frmbufwr__l2_8h.html#a1c2b64db6af3f69c6dade2f84cba18f6">XVFrmbufWr_IsYUVX12Enabled</a>, <a class="el" href="xv__frmbufwr__l2_8h.html#a417e541e7cb4be763f8cce44e3839fdd">XVFrmbufWr_IsYUVX8Enabled</a>, and <a class="el" href="xv__frmbufwr__l2_8h.html#ace6c2de36a55c6fb4a000609a88c8348">XVFrmbufWr_IsYUYV8Enabled</a>.</p>

</div>
</div>
<a class="anchor" id="gaf68f85db7571469e49626a9483567a50"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XVFrmbufWr_SetVChromaBufferAddr </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___frmbuf_wr__l2.html">XV_FrmbufWr_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">UINTPTR&#160;</td>
          <td class="paramname"><em>Addr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sets the buffer address for the V plane for 3 planar formats. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to core instance to be worked upon </td></tr>
    <tr><td class="paramname">Addr</td><td>is the absolute address of buffer in memory</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS or XST_FAILURE </dd></dl>

<p>References <a class="el" href="struct_x_v__frmbufwr.html#ac6a008e283f98889377df951199c4a5b">XV_frmbufwr::Config</a>, <a class="el" href="struct_x_v___frmbuf_wr__l2.html#a82fac99cfaebc558120fd4b5060fc146">XV_FrmbufWr_l2::FrmbufWr</a>, and <a class="el" href="struct_x_v__frmbufwr___config.html#a067ead64f4f249d893081d4626bdb7a1">XV_frmbufwr_Config::PixPerClk</a>.</p>

</div>
</div>
<a class="anchor" id="ga62c170ef332a536b7461b3ce81def351"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XVFrmbufWr_Start </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___frmbuf_wr__l2.html">XV_FrmbufWr_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function starts the core instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to core instance to be worked upon</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none </dd></dl>

<p>References <a class="el" href="struct_x_v___frmbuf_wr__l2.html#a82fac99cfaebc558120fd4b5060fc146">XV_FrmbufWr_l2::FrmbufWr</a>.</p>

</div>
</div>
<a class="anchor" id="ga0cfe9c77cc5534a27e613e5fc87a8ab4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XVFrmbufWr_Stop </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___frmbuf_wr__l2.html">XV_FrmbufWr_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function stops the core instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to core instance to be worked upon</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if the core is stop state XST_FAILURE if the core is not in stop state </dd></dl>

<p>References <a class="el" href="struct_x_v___frmbuf_wr__l2.html#a82fac99cfaebc558120fd4b5060fc146">XV_FrmbufWr_l2::FrmbufWr</a>.</p>

</div>
</div>
<a class="anchor" id="ga28dc4f189245f3c9e8152ff270a40813"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XVFrmbufWr_WaitForIdle </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___frmbuf_wr__l2.html">XV_FrmbufWr_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function Waits for the core to reach idle state. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to core instance to be worked upon</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if the core is in idle state XST_FAILURE if the core is not in idle state </dd></dl>

<p>References <a class="el" href="struct_x_v___frmbuf_wr__l2.html#a82fac99cfaebc558120fd4b5060fc146">XV_FrmbufWr_l2::FrmbufWr</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
